dxp-ux
l22-itv/Get PlanDetails By PlanInstanceId ( TMF-622 )
/productOrder (v1):
This operation provides following features for
PR:
- To retrieve the list of AddOn's of the product
- List the plan instance information from the Aria (Billing System) by using plan instance id
CWC Markets:
To retrieve the history of loan details from evolving system.
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/productOrderURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one for Peacock Mobile project is : "PR"-Puerto Rico | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| channel.name | string | Source System information for tracking purpose. Note for PR: Expected values are either 'Digital' | Y(PR - AddOn), N/A(CWC) |
| relatedParty.id | string | Mobile Device number (msisdn is mandatory to get compatible addons for the associated plan) | Y(PR- AddOn, CWC) |
| orderDate.gte | date-time | To retrieve the loan details performed after this date | N/A(PR),N(CWC) |
| orderDate.lte | date-time | To retrieve the loan details performed before this date | N/A(PR),N(CWC) |
| productOrderItem.product.id | String | The client defined ID of the plan instance Note - To work this functionality the "productOrderItem.product.id" should be expected in request. | Y(PR - planInstance Info), N/A(CWC) |
Definitions
Each of the response parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | ID created on repository side | N(CWC), N/A(PR) |
| category | string | Used to categorize the order from a business perspective | Y(CWC), N/A(PR) |
| orderDate | string($date-time) | Date when the order was created | Y(CWC), N/A(PR) |
| channel[] | array | Related channel to another entity. | N(CWC), N/A(PR) |
| channel[].name | string | Name of the channel | N(CWC), N/A(PR) |
| @type | String | When sub-classing, this defines the sub-class entity name | N(PR,CWC) |
| note | array | Extra information about a given entity | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| note.text | String | Text of the note. | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem[] | Object Array | Product order item array | N(PR), Y(CWC) |
| productOrderItem[].id | string | Identifier of the line item Note for PR : The Aria assigned ID of the plan for this client plan instance id | N(CWC, PR - planInstance Info), N/A(PR - AddOn) |
| productOrderItem[].quantity | string | Quantity ordered Note for PR: The number of units assigned to this instance | N(CWC, PR - planInstance Info), N/A(PR - AddOn) |
| productOrderItem[].action | string | action to be performed on the product | N(CWC), N/A(PR) |
| productOrderItem[].productOffering | object | ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. | N(CWC), N/A(PR) |
| productOrderItem[].productOffering.'@type' | string | The actual type of the target instance when needed for disambiguation. | N(CWC), N/A(PR ) |
| productOrderItem[].itemPrice[] | array | An amount, usually of money, that represents the actual price paid by the Customer for this item or this order | Y(CWC), N/A(PR) |
| productOrderItem[].itemPrice[].description | string | A narrative that explains in detail the semantics of this order item price. | N(CWC), N/A(PR) |
| productOrderItem[].itemPrice[].name | string | A short descriptive name | Y(CWC), N/A(PR) |
| productOrderItem[].itemPrice[].priceType | string | A category that describes the price, such as recurring, discount, allowance, penalty, and so forth | N(CWC), N/A(PR) |
| productOrderItem[].itemPrice[].price | object | Provides all amounts | Y(CWC), N/A(PR ) |
| productOrderItem[].itemPrice[].price.dutyFreeAmount | object | A base / value business entity used to represent money | Y(CWC), N/A(PR) |
| productOrderItem[].itemPrice[].price.dutyFreeAmount.unit | string | Currency | Y(CWC), N/A(PR ) |
| productOrderItem[].itemPrice[].price.dutyFreeAmount.value | number($float) | A positive floating point number | Y(CWC), N/A(PR ) |
| productOrderItem[].'@type' | string | When sub-classing, this defines the sub-class entity name | N(CWC, PR - planInstance Info), N/A(PR - AddOn) |
| productOrderItem.product | Object Array | A product to be created defined by value or existing defined by reference. | N(PR),N/A(CWC) |
| productOrderItem.product.id | String | Unique identifier of the product. | N(PR),N/A(CWC) |
| productOrderItem.product.name | String | Name of the product. It could be the same as the name of the product offering. | N(PR),N/A(CWC) |
| productOrderItem.product.description | string | The name of the plan on this instance | N(PR - planInstance Info), N/A(PR - AddOn, CWC) |
| productOrderItem.product.status | string | The status code of the plan instance. Possible values are: inactive active cancellation pending termination pending installation pending registerd pending activation active trial active non-billable suspended cancelled terminated | N(PR - planInstance Info), N/A(PR - AddOn, CWC) |
| productOrderItem.product.@type | String | type of the product. | N(PR),N/A(CWC) |
| productOrderItem.product. productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. | N(PR - planInstance Info), N/A(PR - AddOn, CWC) |
| productOrderItem.product. productCharacteristic.name | string | Name of the characteristic | N(PR - planInstance Info), N/A(PR - AddOn, CWC) |
| productOrderItem.product. productCharacteristic.value | string | The value of the characteristic | N(PR - planInstance Info), N/A(PR - AddOn, CWC) |
| productOrderItem.product. productCharacteristic.@type | string | Type of characteristic | N(PR - planInstance Info), N/A(PR - AddOn, CWC) |
| productOrderItem.productOrderItem | Object Array | Product order item array | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.@type | String | type of the product. | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product | Object Array | A product to be created defined by value or existing defined by reference. | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.id | String | Unique identifier of the product. | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.name | String | Name of the product. It could be the same as the name of the product offering. | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.itemPrice | Object Array | An amount, usually of money, that represents the actual price paid by the Customer for this item or this order. | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.itemPrice.name | String | name of the priced item | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.itemPrice.description | String | description of the priced item | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.itemPrice.price | Object | item price object | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.itemPrice.price.dutyFreeAmount | Object | duty free amount object | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.itemPrice.price.dutyFreeAmount.unit | String | units of the amount | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| productOrderItem.productOrderItem.product.itemPrice.price.dutyFreeAmount.value | number | price value | N(PR - AddOn),N/A(CWC, PR - planInstance Info) |
| relatedParty[] | array | Related Entity reference. A related party defines party or party role linked to a specific entity. | Y(CWC), N/A(PR - AddOn), N(PR-planInstance Info) |
| relatedParty[].id | string | Unique identifier of a related entity. | Y(CWC), N/A(PR - AddOn), N(PR-planInstance Info) |
| relatedParty[].'@type' | string | When sub-classing, this defines the sub-class entity name | N(CWC), N/A(PR - AddOn), N(PR-planInstance Info) |
| relatedParty[].'@referredType' | string | The actual type of the target instance when needed for disambiguation. | N(CWC), N/A(PR) |
itemPrice[] subResource dataModel:
| name | type | Description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| TransactionAmount | string | Monetary amount involved in the loan transaction | Y(CWC) | CWC: { "description": "TransactionAmount", "name": "TransactionAmount", "priceType": "nonRecurring", "price": { "dutyFreeAmount": { "unit": " __COMPONENT_PLACEHOLDER__ quot;,"value": 100 } } } |
| TransactionPoints | string | Reward or loyalty points associated with the transaction | Y(CWC) | CWC: { "description": "TransactionPoints", "name": "TransactionPoints", "priceType": "nonRecurring", "price": { "dutyFreeAmount": { "unit": "points", "value": 0 } } } |
productCharacteristic values for PR (List the plan instance information from the Aria)
| Characteristic Name | type | description | required |
|---|---|---|---|
| Original Financed Amount | string | The value that was assigned to this field on this plan instance | N |
| Number of Payment Installments | string | The value that was assigned to this field on this plan instance | N |
| Remaining Financed Amount | string | The value that was assigned to this field on this plan instance | N |
| Number of Installments Invoiced | string | The value that was assigned to this field on this plan instance | N |
| Monthly Installment | string | The value that was assigned to this field on this plan instance | N |
| Installment ID | string | The value that was assigned to this field on this plan instance | N |
| Description (English) | string | The value that was assigned to this field on this plan instance | N |
| Description (Spanish) | string | The value that was assigned to this field on this plan instance | N |
| Established On | string | The value that was assigned to this field on this plan instance | N |
| Status | string | The value that was assigned to this field on this plan instance | N |
| Promotional Amount Total | string | The value that was assigned to this field on this plan instance | N |
| Promotional Monthly Amount | string | The value that was assigned to this field on this plan instance | N |
| Number of Promo Discounts | string | The value that was assigned to this field on this plan instance | N |
| Number of Promo Discounts Given | string | The value that was assigned to this field on this plan instance | N |
| Current Promotional Discount Balance | string | The value that was assigned to this field on this plan instance | N |
| Promo Description (English) | string | The value that was assigned to this field on this plan instance | N |
| Promo Description (Spanish) | string | The value that was assigned to this field on this plan instance | N |
| last_bill_date | datetime | The last date on which the plan instance was billed | N |
| next_bill_date | datetime | The next date on which the plan instance is scheduled to be billed | N |
| bill_thru_date | datetime | The date through which the plan instance has been billed | N |
Key considerations
- Please find the responses in following URL DXP UX - GET ProductOrder-v1
CWC Implementation:
- This use case retrieves history of loan details for PREPAID customers from the evolving system based on the MSISDN provided.
- This is implemented for the following businessIds: AI, AG, BB, VG, KY, DM, GD, JM, MS, KN, LC, VC, TT, TC, CW.
- To retrieve loan history for a specific duration, orderDate.gte and orderDate.lte queryParameters must be passed.
- If orderDate.gte is provided, then orderDate.lte must also be provided, and vice versa.
/productOrder (v2):
This operation list the plan instance information from the Aria (Billing System) by using plan instance id (v2)
URL
https://[localhost]:[port]/dxp-ux/v2/{businessId}/productOrderurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| productOrderItem.product.id | String | The client defined ID of the plan instance Note - To work this functionality the "productOrderItem.product.id" should be expected in request. | Y |
Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| billingAccount | object | BillingAccount reference. | N |
| billingAccount.id | string | Client specified account identifier | N |
| billingAccount.@type | string | Billing Account Type | N |
| productOrderItem | array | An identified part of the order. A product order is decomposed into one or more order items. | N |
| productOrderItem.id | string | The Aria assigned ID of the plan for this client plan instance id | N |
| productOrderItem.quantity | integer | The number of units assigned to this instance | N |
| productOrderItem.product | object | A product to be created defined by value or existing defined by reference. | N |
| productOrderItem.product.id | string | The client defined ID of the plan instance | N |
| productOrderItem.product.name | string | The client defined ID of the plan on this instance | N |
| productOrderItem.product.description | string | The name of the plan on this instance | N |
| productOrderItem.product.status | string | The status code of the plan instance. Possible values are: inactive active cancellation pending termination pending installation pending registerd pending activation active trial active non-billable suspended cancelled terminated | N |
| productOrderItem.product. productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. | N |
| productOrderItem.product. productCharacteristic.name | string | Name of the characteristic | N |
| productOrderItem.product. productCharacteristic.value | string | The value of the characteristic | N |
| @type | string | Order type | N |
productCharacteristic values
| Characteristic Name | type | description | required |
|---|---|---|---|
| Original Financed Amount | string | The value that was assigned to this field on this plan instance | N |
| Number of Payment Installments | string | The value that was assigned to this field on this plan instance | N |
| Remaining Financed Amount | string | The value that was assigned to this field on this plan instance | N |
| Number of Installments Invoiced | string | The value that was assigned to this field on this plan instance | N |
| Monthly Installment | string | The value that was assigned to this field on this plan instance | N |
| Installment ID | string | The value that was assigned to this field on this plan instance | N |
| Description (English) | string | The value that was assigned to this field on this plan instance | N |
| Description (Spanish) | string | The value that was assigned to this field on this plan instance | N |
| Established On | string | The value that was assigned to this field on this plan instance | N |
| Status | string | The value that was assigned to this field on this plan instance | N |
| Promotional Amount Total | string | The value that was assigned to this field on this plan instance | N |
| Promotional Monthly Amount | string | The value that was assigned to this field on this plan instance | N |
| Number of Promo Discounts | string | The value that was assigned to this field on this plan instance | N |
| Number of Promo Discounts Given | string | The value that was assigned to this field on this plan instance | N |
| Current Promotional Discount Balance | string | The value that was assigned to this field on this plan instance | N |
| Promo Description (English) | string | The value that was assigned to this field on this plan instance | N |
| Promo Description (Spanish) | string | The value that was assigned to this field on this plan instance | N |
| last_bill_date | datetime | The last date on which the plan instance was billed | N |
| next_bill_date | datetime | The next date on which the plan instance is scheduled to be billed | N |
| bill_thru_date | datetime | The date through which the plan instance has been billed | N |
| plan_type | string | Indicates plan instance | N |
Key considerations
- Please find the responses in following URL DXP UX - GET ProductOrder-v2